GET
/
public
/
v1
/
toppie
/
campaigns
/
{campaign-id}

Path Parameters

​
campaign-id
string
required

The ID of the campaign.

Response

200
application/json
Successful Response

Represents a public version of an agency campaign, used in API responses.

​
accountId
string
required

Account that owns this campaign

​
adFormat
enum<string>
required

The ads format for this campaign (only listing is currently supported)

Available options:
listing,
banner,
exclusive_listing
​
budget
integer
required

Total budget for this campaign

​
budgetPeriod
enum<string>
required

The periodicity of the budget

Available options:
daily,
weekly,
monthly,
total
​
chargeType
enum<string>
required

The charge type for this campaign

Available options:
CPM,
CPC,
CPA
​
createdAt
string
required

Date and time when the campaign was created

​
currencyCode
string
required

Currency code this campaign is working with in ISO 4217 format

​
id
string
required

Internal identifier for the agency campaign

​
isActive
boolean
required

Flag to indicate if the campaign is active or not

​
name
string
required

Campaign name

​
targetRoas
number
required

Target ROAS for the campaign

Required range: 0.5 < x < 20
​
bidCount
integer

Bid count for the campaign (optional)

​
endDate
string

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

​
startDate
string

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.